home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / scale.n < prev    next >
Text File  |  1994-09-20  |  10KB  |  331 lines
  1.  
  2.  
  3.  
  4. scale(n)                   Tk Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      scale - Create and manipulate scale widgets
  12.  
  13. SYNOPSIS
  14.      scale _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
  15.  
  16. STANDARD OPTIONS
  17.      activeForeground               borderWidth     fontorient     |
  18.      background      cursor         foreground      relief         |
  19.  
  20.      See the ``options'' manual entry for details on the standard
  21.      options.
  22.  
  23. WIDGET-SPECIFIC OPTIONS
  24.      Name:           command
  25.      Class:          Command
  26.      Command-Line Switch:-command
  27.  
  28.           Specifies the prefix of a Tcl command to  invoke  when-
  29.           ever  the  value of the scale is changed interactively.
  30.           The actual command consists of this option followed  by
  31.           a  space  and  a  number.  The number indicates the new
  32.           value of the scale.
  33.  
  34.      Name:           from
  35.      Class:          From
  36.      Command-Line Switch:-from
  37.  
  38.           Specifies the value corresponding to the  left  or  top
  39.           end of the scale.  Must be an integer.
  40.  
  41.      Name:           label
  42.      Class:          Label
  43.      Command-Line Switch:-label
  44.  
  45.           Specifies a string to displayed  as  a  label  for  the
  46.           scale.  For vertical scales the label is displayed just
  47.           to the right of the top end of the scale.  For horizon-
  48.           tal  scales  the label is displayed just above the left
  49.           end of the scale.
  50.  
  51.      Name:           length
  52.      Class:          Length
  53.      Command-Line Switch:-length
  54.  
  55.           Specifies the desired long dimension of  the  scale  in  |
  56.           screen  units  (i.e.  any  of  the  forms acceptable to  |
  57.           Tk_GetPixels).  For vertical scales this is the scale's
  58.           height;  for horizontal scales it is the scale's width.
  59.  
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. scale(n)                   Tk Commands
  71.  
  72.  
  73.  
  74.      Name:           showValue
  75.      Class:          ShowValue
  76.      Command-Line Switch:-showvalue
  77.  
  78.           Specifies a boolean value indicating whether or not the
  79.           current value of the scale is to be displayed.
  80.  
  81.      Name:           sliderForeground
  82.      Class:          sliderForeground
  83.      Command-Line Switch:-sliderforeground
  84.  
  85.           Specifies the color to use for drawing the slider under
  86.           normal  conditions.   When  the  mouse is in the slider
  87.           window then the slider's color  is  determined  by  the
  88.           activeForeground option.
  89.  
  90.      Name:           sliderLength
  91.      Class:          SliderLength
  92.      Command-Line Switch:-sliderlength
  93.  
  94.           Specfies the size of the  slider,  measured  in  screen  |
  95.           units along the slider's long dimension.  The value may  |
  96.           be  specified  in  any  of  the  forms  acceptable   to  |
  97.           Tk_GetPixels.                                            |
  98.  
  99.      Name:           state                                         |
  100.      Class:          State                                         |
  101.      Command-Line Switch:-state                                    |
  102.  
  103.                                                                         ||
  104.           Specifies  one  of two states for the scale:  normal or  |
  105.           disabled.  If the scale is disabled then the value  may  |
  106.           not  be  changed  and the scale won't activate when the  |
  107.           mouse enters it.
  108.  
  109.      Name:           tickInterval
  110.      Class:          TickInterval
  111.      Command-Line Switch:-tickinterval
  112.  
  113.           Must be  an  integer  value.   Determines  the  spacing
  114.           between  numerical tick-marks displayed below or to the
  115.           left of the slider.  If specified as 0, then  no  tick-
  116.           marks will be displayed.
  117.  
  118.      Name:           to
  119.      Class:          To
  120.      Command-Line Switch:-to
  121.  
  122.           Specifies the value corresponding to the right or  bot-
  123.           tom  end of the scale.  Must be an integer.  This value
  124.           may be either  less  than  or  greater  than  the  from
  125.           option.
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. scale(n)                   Tk Commands
  137.  
  138.  
  139.  
  140.      Name:           width
  141.      Class:          Width
  142.      Command-Line Switch:-width
  143.  
  144.           Specifies the desired narrow dimension of the scale  in  |
  145.           screen  units  (i.e.  any  of  the  forms acceptable to  |
  146.           Tk_GetPixels).  For vertical scales this is the scale's
  147.           width;   for  horizontal  scales  this  is  the scale's
  148.           height.
  149. _________________________________________________________________
  150.  
  151.  
  152. DESCRIPTION
  153.      The scale command creates a new window (given by  the  _p_a_t_h_-
  154.      _N_a_m_e argument) and makes it into a scale widget.  Additional
  155.      options, described above, may be specified  on  the  command
  156.      line  or  in the option database to configure aspects of the
  157.      scale such as its  colors,  orientation,  and  relief.   The
  158.      scale  command  returns  its _p_a_t_h_N_a_m_e argument.  At the time
  159.      this command is invoked, there must not exist a window named
  160.      _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.
  161.  
  162.      A scale is a widget that displays a rectangular region and a
  163.      small _s_l_i_d_e_r.  The rectangular region corresponds to a range
  164.      of integer values (determined by the from and  to  options),
  165.      and  the position of the slider selects a particular integer
  166.      value.  The slider's position (and hence the scale's  value)
  167.      may  be  adjusted  by clicking or dragging with the mouse as
  168.      described in  the  BINDINGS  section  below.   Whenever  the
  169.      scale's  value  is  changed, a Tcl command is invoked (using
  170.      the command option) to notify other  interested  widgets  of
  171.      the change.
  172.  
  173.      Three annotations may be displayed in  a  scale  widget:   a
  174.      label appearing at the top-left of the widget (top-right for
  175.      vertical scales), a number  displayed  just  underneath  the
  176.      slider (just to the left of the slider for vertical scales),
  177.      and a collection of numerical tick-marks just underneath the
  178.      current  value  (just  to  the left of the current value for
  179.      vertical scales).  Each of these three  annotations  may  be
  180.      selectively  enabled  or  disabled  using  the configuration
  181.      options.
  182.  
  183.  
  184. WIDGET COMMAND
  185.      The scale command creates a new Tcl command  whose  name  is
  186.      _p_a_t_h_N_a_m_e.  This command may be used to invoke various opera-
  187.      tions on the widget.  It has the following general form:
  188.  
  189.           _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  190.  
  191.      _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the com-
  192.      mand.    The  following  commands  are  possible  for  scale
  193.  
  194.  
  195.  
  196. Tk                                                              3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. scale(n)                   Tk Commands
  203.  
  204.  
  205.  
  206.      widgets:
  207.  
  208.      _p_a_t_h_N_a_m_e configure ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  209.           Query  or  modify  the  configuration  options  of  the
  210.           widget.   If  no  _o_p_t_i_o_n  is  specified, returns a list
  211.           describing all of the available  options  for  _p_a_t_h_N_a_m_e
  212.           (see  Tk_ConfigureInfo for information on the format of
  213.           this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  214.           the  command  returns  a  list describing the one named
  215.           option (this list will be identical to the  correspond-
  216.           ing  sublist  of  the  value  returned  if no _o_p_t_i_o_n is
  217.           specified).  If one  or  more  _o_p_t_i_o_n-_v_a_l_u_e  pairs  are
  218.           specified,  then  the command modifies the given widget
  219.           option(s) to have the given value(s);  in this case the
  220.           command  returns  an empty string.  _O_p_t_i_o_n may have any
  221.           of the values accepted by the scale command.
  222.  
  223.      _p_a_t_h_N_a_m_e get
  224.           Returns a decimal string giving the  current  value  of
  225.           the scale.
  226.  
  227.      _p_a_t_h_N_a_m_e set _v_a_l_u_e
  228.           This command is invoked to change the current value  of
  229.           the  scale,  and hence the position at which the slider
  230.           is displayed.  _V_a_l_u_e gives the new value for the scale.
  231.  
  232.  
  233. BINDINGS
  234.      When a new scale is created, it is given the following  ini-
  235.      tial behavior by default:
  236.  
  237.      <Enter>             Change  the  slider   display   to   use
  238.                          activeForeground  instead of sliderFore-
  239.                          ground.
  240.  
  241.      <Leave>             Reset the slider display to use  slider-
  242.                          Foreground instead of activeForeground.
  243.  
  244.      <ButtonPress-1>     Change the slider display  so  that  the
  245.                          slider   appears   sunken   rather  than
  246.                          raised.  Move the slider (and adjust the
  247.                          scale's  value)  to  correspond  to  the
  248.                          current mouse position.
  249.  
  250.      <Button1-Motion>    Move the slider (and adjust the  scale's
  251.                          value)  to  correspond  to  the  current
  252.                          mouse position.
  253.  
  254.      <ButtonRelease-1>   Reset the slider  display  so  that  the
  255.                          slider appears raised again.
  256.  
  257.  
  258.  
  259.  
  260.  
  261. Tk                                                              4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. scale(n)                   Tk Commands
  269.  
  270.  
  271.  
  272. KEYWORDS
  273.      scale, widget
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. Tk                                                              5
  328.  
  329.  
  330.  
  331.